Skip to content

Comprehensive In-Memory Caching (fix #404) #427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Comprehensive In-Memory Caching (fix #404) #427

wants to merge 3 commits into from

Conversation

@mokarchi
Copy link

@mokarchi mokarchi commented Oct 24, 2025

How It Works

When you call new ArchLoader().LoadAssemblies(...).Build(), ArchUnitNET automatically:

  1. Creates a cache key based on the modules being loaded and any namespace filters applied
  2. Checks the cache for a previously loaded Architecture instance matching this key
  3. Returns the cached instance if found, or loads and caches a new instance if not

This means that loading the same assemblies multiple times (even with different ArchLoader instances) will reuse the cached Architecture object, providing dramatic performance improvements.

Usage Examples

Basic usage (automatic caching with file-based invalidation):

var arch = new ArchLoader()
    .LoadAssemblies(assembly)
    .Build(); // Automatically cached with invalidation

Custom cache key for test isolation:

var arch = new ArchLoader()
    .WithUserCacheKey("test-run-1")
    .LoadAssemblies(assembly)
    .Build();

Disable caching for specific scenarios:

var arch = new ArchLoader()
    .WithoutCaching()
    .LoadAssemblies(assembly)
    .Build();

Advanced configuration (config is cloned internally):

var config = new ArchLoaderCacheConfig
{
    CachingEnabled = true,
    UseFileBasedInvalidation = true, // Check file changes
    UserCacheKey = "integration-tests",
    IncludeVersionInCacheKey = true // Invalidate on version change
};

var arch = new ArchLoader()
    .WithCacheConfig(config)
    .LoadAssemblies(assembly)
    .Build();

// Safe: modifying config after passing it won't affect the ArchLoader
config.UserCacheKey = "different-key";

alexanderlinne and others added 2 commits October 25, 2025 08:37
@alexanderlinne @mokarchi
Don't override run-name in build.yaml
51d6e8c 
Signed-off-by: Alexander Linne <[email protected]>
Signed-off-by: mokarchi <[email protected]>
@mokarchi
Add enhanced caching mechanism for ArchLoader builds
f7080a4 
Introduced a new caching system via `ArchitectureCacheManager` to improve performance and efficiency of `ArchLoader` builds. The caching mechanism supports file-based invalidation, user-defined cache keys, and version-based cache invalidation.

Key changes:
- Added `ArchitectureCacheManager` for centralized caching.
- Introduced `ArchLoaderCacheConfig` for configurable caching options.
- Added `AssemblyMetadata` to track assembly file changes.
- Enhanced `ArchBuilder` with a new `Build` method supporting caching.
- Improved `ArchLoader` with fluent API methods for caching configuration.
- Added extensive unit tests to validate caching behavior and performance.

Refactored code to integrate caching seamlessly while maintaining backward compatibility. Improved performance for repeated builds of the same assemblies.

Signed-off-by: mokarchi <[email protected]>
@mokarchi
Copy link
Author

mokarchi commented Oct 25, 2025

@alexanderlinne Could you review this, please?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mokarchi @alexanderlinne